##
# \file rewards.py
#

# --  Python imports  --
# -- End Python imports --

# --  Pybrain imports  --
# -- End Pybrain imports --

# --  Project imports  --
# -- End Project imports --

##
# \class Reward
# \details This class gives real values to the rewards the agent can receive.
class Reward:
    ## \var BUST
    # This is the reward the agent receives when it busts.
    BUST = -1.0

    ## \var WIN
    # This is the reward the agent receives when it wins against the dealer.
    WIN  = 3.0

    ## \var LOSE
    # This is the reward the agent receives when it loses against the dealer.
    LOSE = -2.0

    ## \var PUSH
    # This is the reward the agent receives when it ties against the dealer.
    PUSH = 0.5

    ## \var DEALER_BUST
    # This is the reward the agent receives when the \b dealer \b busts.
    DEALER_BUST  = 1.5

    ## \var KEEP_PLAYING
    # This is the reward the agent receives for intermediate play, when
    # none of the other rewards are relevant.
    KEEP_PLAYING = 0.0
